Sipp Knowledge Base

Welcome to the public documentation for the Sipp iOS project. These pages mirror the files inside this repository's docs/ folder, which is served via GitHub Pages when enabled.

Available Guides

• User Manual: Consumer-facing walkthrough that explains signing in, ordering, paying for memberships (Apple vs. Stripe), and shop features.
• QA Test Plan: Comprehensive checklist for regression passes, plus guidance for filing detailed QA tickets.

Publishing via Cloudflare Pages

1. In the repo root, the script scripts/build-docs.sh converts the Markdown files in docs/ into static HTML inside public/. The script installs Python's markdown module automatically.
2. Configure Cloudflare Pages with:
3. Build command: bash scripts/build-docs.sh
4. Deploy command: bash scripts/deploy-docs.sh
5. Output directory: public
6. Every push to main will rebuild the docs; the resulting site contains index.html, USER_MANUAL.html, and QA_TEST_PLAN.html linked via a simple nav bar.

You can also deploy manually using the Cloudflare CLI:

npx wrangler pages project create sipp-doc # first time only
bash scripts/build-docs.sh
wrangler pages deploy public --project-name sipp-doc

Adjust the project name or branch as needed for staging environments.

Add new guides directly under docs/ and link them here so they appear automatically on the GitHub Pages site once published.